Run On Demand Schedules

{ runOnDemandSchedules }

Runs all 'On-Demand' schedules for the selected model.

Method

/API2/tasks/runOnDemandSchedules

  • API Section: /API2/tasks
  • API Version: 2.0
  • From Release: 2023.00
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Input Parameters

    Name

    scheduleOnDemandObject

    Object Type

    ModelScheduleOnDemandObject

    Description

    Details of the model that will be the target of the on-demand execution.

    Output Response

    Successful Result Code

    200

    Response Type

    ModelScheduleOnDemandResult

    Description of Response Type

    A listing of on-demand schedules triggered by the change

    Notes

    This function will only operate against items that have employed the 'on-demand' schedule mechanism for Publications, Alerts and Subscriptions. The mechanism will only affect those item schedules that are fully or partially attached to the selected model.